-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docs): add workflow to generate documentation on PR merge #12681
base: master
Are you sure you want to change the base?
feat(docs): add workflow to generate documentation on PR merge #12681
Conversation
@virajbhartiya can you resolve the conflict with |
Hey @rvagg, I have resolved the conflicts in the PR |
@rvagg any suggestions on why is the workflow failing? |
Failing because you need to install system dependencies for the build in check.yml, you'll see: - uses: ./.github/actions/install-system-dependencies
- uses: ./.github/actions/install-go
- uses: ./.github/actions/make-deps these are required to perform the actions you need, so you'll have to do it again in your new job but, having said that, it's not cheap, so maybe this should all be in a single job so that's all done once and it's just the docsgen-cli bit that's done separately. So how about this:
I'm still not convinced this is a great idea, it might get in the way. So we'll need to have a collective chat with others before we proceed. |
Hey @rvagg thanks for the review, I have currently modified it accordingly, renamed check.yml to check-and-gen.yml and added it in the same file. We can discuss regarding this on slack wtih other how to go ahead with this PR |
I know there have been verbal conversation on this one. Did we write out the next steps? |
Didn't write it out, but next steps are to get this completed and merged and then experience it live and decide whether we hate it or love it and whether it's a QoL improvement on balance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, https://github.com/ipdxco/github-as-code/blob/master/.github/workflows/fix.yml is a working example of a workflow that runs on PRs and writes to PR branches.
@rvagg : do you think we can do the next steps in #12681 (comment) this week to run the experiment? (Or have new thoughts come in and we defer for now.) |
@virajbhartiya : is the final feedback something you'll be able to incorporate or does someone else need to take this? |
ebcb89a
to
dfc31a3
Compare
I hope you don't mind @virajbhartiya but I've squashed this down to one commit, rebased on master, added a little fix to make sure this is only done on PRs and have force pushed all of that to your branch |
dfc31a3
to
b16e324
Compare
OK, I'm pushing my latest attempt at this and giving up for now, it's driving me mad.
As of now, @virajbhartiya's |
@galargh : if you are up for timeboxing 1 hour to land this, that's great. I wouldn't want to spend more than an hour here though as we are ok to close it too. |
This is a minimal example of a workflow committing to pull requests (including public, non-org forks where the user allowed maintainer edits) - https://github.com/galorgh/.github/blob/master/.github/workflows/playground3.yml It requires the use of The pushed commit doesn't trigger any more workflows by design. This means it is not suitable for repos with required checks. The way to overcome the limitations of this approach is to use custom credentials - either bot account's PAT or designated GItHub App's secrets. |
Related Issues
Closes #12233
Proposed Changes
Add a workflow that run
make docsgen-cli
whenever the PR is mergedChecklist